feat(docs): add HTTP markdown negotiation support #5321
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Upgrade fumadocs-core from 15.1.0 to 15.8.3 to access the new negotiation API for HTTP content negotiation support. This enables serving markdown to AI agents while maintaining HTML for browsers.
Add dynamic route handler at /llms.mdx/[[...slug]]/ that serves markdown versions of documentation pages. This enables AI agents to fetch markdown content for specific pages with proper text/markdown Content-Type headers. - Uses existing getLLMText() helper for content processing - Supports static generation via generateStaticParams() - Returns 404 for non-existent pages
Implement Next.js middleware that detects when clients prefer markdown (via Accept header) and rewrites requests to serve markdown instead of HTML. This enables AI agents like Claude Code to seamlessly access documentation in markdown format. - Uses fumadocs-core negotiation API - Excludes API routes and static assets - Non-intrusive: browsers continue receiving HTML
Add Next.js rewrites to handle explicit .md and .mdx extension requests, routing them to the markdown handler. This allows users to append .md or .mdx to any doc URL to get markdown content. Examples: - /basics.md → /llms.mdx/basics - /library-authors.mdx → /llms.mdx/library-authors
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
Adds HTTP content negotiation support to the Zod documentation site, enabling AI agents (like Claude Code) to receive markdown instead of HTML while maintaining HTML for regular browsers.
This implementation follows the pattern established in fumadocs PRs:
Changes
fumadocs-corefrom 15.1.0 to 15.8.3 to access the new negotiation API/llms.mdx/[[...slug]]/that serves markdown versions of documentation pagesContent negotiation middleware
AcceptheaderStatic rewrites for extensions
.mdand.mdxextension requests/basics.md→ markdown,/library-authors.mdx→ markdownHow it works
For AI agents:
Accept: text/markdownheader → receives markdown/basics.mdor/basics.mdx→ receives markdownFor browsers:
References